Typ złożony Response

Opis

Rezultat przetworzenia operacji

Typ zawierający listę możliwych rezultatów przetworzenia operacji.

Przestrzeń nazw

http://api.big.pl/bimoS/v1

Typ podstawowy

Extension of Typ złożony ResponseAbstract

Diagram

Przegląd

Response Extension of Typ złożony ResponseAbstract

Rezultat przetworzenia operacji

Typ zawierający listę możliwych rezultatów przetworzenia operacji.

Choice

authorisationError Typ złożony AuthorisationError

Błąd autoryzacji

Błąd zwracany w wyniku braku uprawnień do przeprowadzenia operacji

Sequence

errorType Typ prosty authErrorTypeEnum

Typ błędu autoryzacji

Typ błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.

errorDescription Typ prosty string

Opis typu błędu autoryzacji

Opis typu błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.

requestError Typ złożony RequestError

Błąd walidacji

Błąd danych zapytania

Sequence

currentRequest optional Typ złożony Request

Bieżące żądanie

Dane dotyczące bieżącego komunikatu żądania (request).

Sequence

Choice

client Typ złożony Subscriber

Klient BIG IM przeprowadzający operację

Element, który zawiera identyfikatory Klienta zlecającego operację

proxy Typ złożony Proxy

Przedstawiciel Klienta

Identyfikatory Przedstawiciela klienta BIG IM, przeprowadzający operację w jego imieniu

validityDateTime optional Typ prosty dateTime

Data i czas aktualności danych

Wskazanie daty i czasu na który aktualne są przekazywane do BIG InfoMonitor dane. Domyślnie SIBIG przyjmuje, że przekazywane dane są aktualne na moment wywołania usługi BIG InfoMonitor przez system Subskrybenta.

operationType optional Typ prosty operationTypeEnum

Rodzaj operacji

Rodzaj operacji zleconej do wykonania.

validationError 1..∞ Typ złożony ValidationError

Błąd walidacji

Informacje dotyczące błędów walidacji, jakie wykrył SIBIG

Sequence

orderNumber Typ prosty int6

Numer kolejny błędu

Numer kolejny błędu walidacji wykrytego w komunikacie. Numeracja zaczyna się od „1”.

validationRuleId Typ prosty string32

Kod błędu

Kod błędu walidacji

message optional Typ prosty string

Opis błędu

Opis błędu walidacji

faultyElementPath optional Typ prosty string

XPath

XPath do błędnej ścieżki komunikatu

dependentElementPath optional Typ prosty string

Xpath do pola zależnego

Xpath do pola zależnego, względem pola, do którego zgłoszony został błąd (@ValidationError.faultyElementPath)

success Typ złożony SuccessResponse

Sukces

Pozytywny rezultat przetwarzania operacji (sukces)

Używany przez

Element addOrderResponse
Element removeOrderResponse
Element getOrderStatusResponse

Źródło

<xs:complexType name="Response" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Rezultat przetworzenia operacji</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ zawierający listę możliwych rezultatów przetworzenia operacji.</div>
    </xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="bc:ResponseAbstract">
      <xs:choice>
        <xs:element name="authorisationError" type="bc:AuthorisationError">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd autoryzacji</div>
              <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd zwracany w wyniku braku uprawnień do przeprowadzenia operacji</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="requestError" type="bs:RequestError">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd walidacji</div>
              <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd danych zapytania</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="success" type="bs:SuccessResponse">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Sukces</div>
              <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Pozytywny rezultat przetwarzania operacji (sukces)</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Zobacz także

Schema bimoS.v1